IRIX Base Documentation 2001 May

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3x / curs_getwch.z / curs_getwch

Wrap

Text File | 1998-10-20 | 12.8 KB | 333 lines

ccccuuuurrrrssss____ggggeeeettttwwwwcccchhhh((((3333XXXX)))) ccccuuuurrrrssss____ggggeeeettttwwwwcccchhhh((((3333XXXX)))) NNNNAAAAMMMMEEEE _cccc_uuuu_rrrr_ssss______gggg_eeee_tttt_wwww_cccc_hhhh: _gggg_eeee_tttt_wwww_cccc_hhhh, _wwww_gggg_eeee_tttt_wwww_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_wwww_cccc_hhhh, _mmmm_vvvv_wwww_gggg_eeee_tttt_wwww_cccc_hhhh, _uuuu_nnnn_gggg_eeee_tttt_wwww_cccc_hhhh - get (or push back) _wwww_cccc_hhhh_aaaa_rrrr______tttt characters from _cccc_uuuu_rrrr_ssss_eeee_ssss terminal keyboard SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> _iiii_nnnn_tttt _gggg_eeee_tttt_wwww_cccc_hhhh_((((_vvvv_oooo_iiii_dddd_))))_;;;; _iiii_nnnn_tttt _wwww_gggg_eeee_tttt_wwww_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_))))_;;;; _iiii_nnnn_tttt _mmmm_vvvv_gggg_eeee_tttt_wwww_cccc_hhhh_((((_iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_))))_;;;; _iiii_nnnn_tttt _mmmm_vvvv_wwww_gggg_eeee_tttt_wwww_cccc_hhhh_((((_WWWW_IIII_NNNN_DDDD_OOOO_WWWW _****_wwww_iiii_nnnn_,,,, _iiii_nnnn_tttt _yyyy_,,,, _iiii_nnnn_tttt _xxxx_))))_;;;; _iiii_nnnn_tttt _uuuu_nnnn_gggg_eeee_tttt_wwww_cccc_hhhh_((((_iiii_nnnn_tttt _wwww_cccc_hhhh_))))_;;;; DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN The _gggg_eeee_tttt_wwww_cccc_hhhh, _wwww_gggg_eeee_tttt_wwww_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_wwww_cccc_hhhh, and _mmmm_vvvv_wwww_gggg_eeee_tttt_wwww_cccc_hhhh routines read an _E_U_C character from the terminal associated with the window, transform it into a _wwww_cccc_hhhh_aaaa_rrrr______tttt character, and return a _wwww_cccc_hhhh_aaaa_rrrr______tttt character. In no-delay mode, if no input is waiting, the value _EEEE_RRRR_RRRR is returned. In delay mode, the program waits until the system passes text through to the program. Depending on the setting of _cccc_bbbb_rrrr_eeee_aaaa_kkkk, this is after one character (_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode), or after the first newline (_nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode). In half-delay mode, the program waits until a character is typed or the specified timeout has been reached. Unless _nnnn_oooo_eeee_cccc_hhhh_oooo has been set, the character will also be echoed into the designated window. If the window is not a pad, and it has been moved or modified since the last call to _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh, _wwww_rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh will be called before another character is read. If _kkkk_eeee_yyyy_pppp_aaaa_dddd is _TTTT_RRRR_UUUU_EEEE, and a function key is pressed, the token for that function key is returned instead of the raw characters. Possible function keys are defined in _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> with integers beginning with _0000_4444_0000_1111, whose names begin with _KKKK_EEEE_YYYY______.... If a character that could be the beginning of a function key (such as escape) is received, _cccc_uuuu_rrrr_ssss_eeee_ssss sets a timer. If the remainder of the sequence does not come in within the designated time, the character is passed through; otherwise, the function key value is returned. For this reason, many terminals experience a delay between the time a user presses the escape key and the escape is returned to the program. The _uuuu_nnnn_gggg_eeee_tttt_wwww_cccc_hhhh routine places _w_c_h back onto the input queue to be returned by the next call to _wwww_gggg_eeee_tttt_wwww_cccc_hhhh. FFFFuuuunnnnccccttttiiiioooonnnn KKKKeeeeyyyyssss The following function keys, defined in _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>>, might be returned by _gggg_eeee_tttt_wwww_cccc_hhhh if _kkkk_eeee_yyyy_pppp_aaaa_dddd has been enabled. Note that not all of these may be supported on a particular terminal if the terminal does not transmit a unique code when the key is pressed or if the definition for the key is not present in the _tttt_eeee_rrrr_mmmm_iiii_nnnn_ffff_oooo database. PPPPaaaaggggeeee 1111 ccccuuuurrrrssss____ggggeeeettttwwwwcccchhhh((((3333XXXX)))) ccccuuuurrrrssss____ggggeeeettttwwwwcccchhhh((((3333XXXX)))) __________________________________________________________________ Name Key name __________________________________________________________________ PPPPaaaaggggeeee 2222 KEY_BREAK Break key KEY_DOWN The four arrow keys ... KEY_UP KEY_LEFT KEY_RIGHT KEY_HOME Home key (upward+left arrow) KEY_BACKSPACE Backspace KEY_F0 Function keys; space for 64 keys is reserved. KEY_F(_n) For 0 _< _n _< 63 KEY_DL Delete line KEY_IL Insert line KEY_DC Delete character KEY_IC Insert char or enter insert mode KEY_EIC Exit insert char mode KEY_CLEAR Clear screen KEY_EOS Clear to end of screen KEY_EOL Clear to end of line KEY_SF Scroll 1 line forward KEY_SR Scroll 1 line backward (reverse) KEY_NPAGE Next page KEY_PPAGE Previous page KEY_STAB Set tab KEY_CTAB Clear tab KEY_CATAB Clear all tabs KEY_ENTER Enter or send KEY_SRESET Soft (partial) reset KEY_RESET Reset or hard reset KEY_PRINT Print or copy Home down or bottom (lower left). Keypad is arranged like this: _AAAA_1111 _uuuu_pppp _AAAA_3333 _llll_eeee_ffff_tttt _BBBB_2222 _rrrr_iiii_gggg_hhhh_tttt _CCCC_1111 _dddd_oooo_wwww_nnnn _CCCC_3333 KEY_LL KEY_A1 Upper left of keypad KEY_A3 Upper right of keypad KEY_B2 Center of keypad KEY_C1 Lower left of keypad KEY_C3 Lower right of keypad KEY_BTAB Back tab key KEY_BEG Beg(inning) key KEY_CANCEL Cancel key KEY_CLOSE Close key KEY_COMMAND Cmd (command) key KEY_COPY Copy key KEY_CREATE Create key KEY_END End key KEY_EXIT Exit key KEY_FIND Find key KEY_HELP Help key KEY_MARK Mark key PPPPaaaaggggeeee 3333 KEY_MESSAGE Message key KEY_MOVE Move key KEY_NEXT Next object key KEY_OPEN Open key KEY_OPTIONS Options key KEY_PREVIOUS Previous object key KEY_REDO Redo key KEY_REFERENCE Ref(erence) key KEY_REFRESH Refresh key KEY_REPLACE Replace key KEY_RESTART Restart key KEY_RESUME Resume key KEY_SAVE Save key KEY_SBEG Shifted beginning key KEY_SCANCEL Shifted cancel key KEY_SCOMMAND Shifted command key KEY_SCOPY Shifted copy key KEY_SCREATE Shifted create key KEY_SDC Shifted delete char key KEY_SDL Shifted delete line key KEY_SELECT Select key KEY_SEND Shifted end key KEY_SEOL Shifted clear line key KEY_SEXIT Shifted exit key KEY_SFIND Shifted find key KEY_SHELP Shifted help key KEY_SHOME Shifted home key KEY_SIC Shifted input key KEY_SLEFT Shifted left arrow key KEY_SMESSAGE Shifted message key KEY_SMOVE Shifted move key KEY_SNEXT Shifted next key KEY_SOPTIONS Shifted options key KEY_SPREVIOUS Shifted prev key KEY_SPRINT Shifted print key KEY_SREDO Shifted redo key KEY_SREPLACE Shifted replace key KEY_SRIGHT Shifted right arrow KEY_SRSUME Shifted resume key KEY_SSAVE Shifted save key KEY_SSUSPEND Shifted suspend key KEY_SUNDO Shifted undo key KEY_SUSPEND Suspend key KEY_UNDO Undo key RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE All routines return the integer _EEEE_RRRR_RRRR upon failure and an integer value other than _EEEE_RRRR_RRRR upon successful completion. PPPPaaaaggggeeee 4444 NOTES The header file _<<<<_cccc_uuuu_rrrr_ssss_eeee_ssss_...._hhhh_>>>> automatically includes the header files _<<<<_ssss_tttt_dddd_iiii_oooo_...._hhhh_>>>> and _<<<<_uuuu_nnnn_cccc_tttt_rrrr_llll_...._hhhh_>>>>. Use of the escape key by a programmer for a single character function is discouraged. When using _gggg_eeee_tttt_wwww_cccc_hhhh, _wwww_gggg_eeee_tttt_wwww_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_wwww_cccc_hhhh, or _mmmm_vvvv_wwww_gggg_eeee_tttt_wwww_cccc_hhhh, _nnnn_oooo_cccc_bbbb_rrrr_eeee_aaaa_kkkk mode and _eeee_cccc_hhhh_oooo mode should not be used at the same time. Depending on the state of the tty driver when each character is typed, the program may produce undesirable results. Note that _gggg_eeee_tttt_wwww_cccc_hhhh, _mmmm_vvvv_gggg_eeee_tttt_wwww_cccc_hhhh, and _mmmm_vvvv_wwww_gggg_eeee_tttt_wwww_cccc_hhhh may be macros. SSSSEEEEEEEE AAAALLLLSSSSOOOO _cccc_uuuu_rrrr_ssss_eeee_ssss(3X), _cccc_uuuu_rrrr_ssss______iiii_nnnn_oooo_pppp_tttt_ssss(3X), _cccc_uuuu_rrrr_ssss______mmmm_oooo_vvvv_eeee(3X), _cccc_uuuu_rrrr_ssss______rrrr_eeee_ffff_rrrr_eeee_ssss_hhhh(3X). PPPPaaaaggggeeee 5555